<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>Open Data Protection C API: include/odpapi.h File Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Open Data Protection C API
   &#160;<span id="projectnumber">10</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="../../index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="../../pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="../../annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="../../files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="../../search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="../../files.html"><span>File&#160;List</span></a></li>
      <li><a href="../../globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">odpapi.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Open Data Protection API Helper Header.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdlib.h&gt;</code><br/>
<code>#include &lt;<a class="el" href="../../d1/d82/cJSON_8h_source.html">cJSON.h</a>&gt;</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for odpapi.h:</div>
<div class="dyncontent">
<div class="center"><img src="../../d2/db1/odpapi_8h__incl.png" border="0" usemap="#include_2odpapi_8h" alt=""/></div>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="../../d9/de2/odpapi_8h__dep__incl.png" border="0" usemap="#include_2odpapi_8hdep" alt=""/></div>
<map name="include_2odpapi_8hdep" id="include_2odpapi_8hdep">
<area shape="rect" id="node2" href="../../d8/d4f/odpapi_8c.html" title="src/odpapi.c" alt="" coords="16,80,109,107"/></map>
</div>
</div>
<p><a href="../../d0/d70/odpapi_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a173a55e8071a19a0345ead2067182a87"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87">ODPAPI_COMMONERROR</a> { <br/>
&#160;&#160;<a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87a30abc33722887bbb08c59eb1ee160e4e">ODPAPI_COMMONERROR_OK</a> = 0, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87ac2f45ac381df116b97f544962cbfac54">ODPAPI_COMMONERROR_PARSEFAILED</a> = 1, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87a951196c13fb81f4d08d9b6a78dcb1f3e">ODPAPI_COMMONERROR_NOTOFFERED</a> = 2, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87af5150692024af47879b46297e2fc1214">ODPAPI_COMMONERROR_NOTPERMITTED</a> = 3, 
<br/>
&#160;&#160;<a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87a71158f3119c02bdb87d81aa182ebcdb9">ODPAPI_COMMONERROR_FAILEDAUTH</a> = 4, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87a71da0fd6e79b4974e2982ee584130b85">ODPAPI_COMMONERROR_ERRORCOMEBACK</a> = 5, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87a130853a151379bc3aae710760699e216">ODPAPI_COMMONERROR_EXCEEDEDALLOWANCE</a> = 6, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87aff3d720e4702d648f3b89c2b4a947d8d">ODPAPI_COMMONERROR_INVALIDUUID</a> = 7, 
<br/>
&#160;&#160;<a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87aca609ac007f0dd1b1c03da8dca227a79">ODPAPI_COMMONERROR_MISSINGARGUMENT</a> = 8, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87a6d7f4258803c0e6f9ffef1861b4f1d5e">ODPAPI_COMMONERROR_MISSINGDATA</a> = 9, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87a0efa20b1ce95a23a78bf5589c57e55d8">ODPAPI_COMMONERROR_SOURCELIBRARYNOTKNOWN</a> = 100, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87ab492457a23bada291884a0d24988eaeb">ODPAPI_COMMONERROR_TARGETLIBRARYNOTKNOWN</a> = 101, 
<br/>
&#160;&#160;<a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87af756e12cea8f4d9297c04cba5e16be71">ODPAPI_COMMONERROR_TARGETLIBRARYSAME</a> = 102, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87a11faffa78ea05084745b2b0225da7f27">ODPAPI_COMMONERROR_LIBRARYCOMPATPROBLEM</a> = 103, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87a55afde4b2afe4f4c28432fc63f9e28aa">ODPAPI_COMMONERROR_UNKNOWN</a> = 1024
<br/>
 }</td></tr>
<tr class="separator:a173a55e8071a19a0345ead2067182a87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dba2207de5e8ecc9baa3a071e12a622"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d70/odpapi_8h.html#a0dba2207de5e8ecc9baa3a071e12a622">ODPAPI_INVENTORYSTATUS</a> { <a class="el" href="../../d0/d70/odpapi_8h.html#a0dba2207de5e8ecc9baa3a071e12a622a9a072be090d2f9f5083399db90b5c79b">ODPAPI_INVENTORYSTATUS_OK</a> = 0, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a0dba2207de5e8ecc9baa3a071e12a622ad0600615bafe4dbf15f12b2573631c1b">ODPAPI_INVENTORYSTATUS_MOVINGIN</a> = 1, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a0dba2207de5e8ecc9baa3a071e12a622adc37834085db8595cfb5544870185143">ODPAPI_INVENTORYSTATUS_MOVINGOUT</a> = 2, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a0dba2207de5e8ecc9baa3a071e12a622a62b49934707eab32ec1b9193e443b190">ODPAPI_INVENTORYSTATUS_NOTPRESENT</a> = 3
 }</td></tr>
<tr class="separator:a0dba2207de5e8ecc9baa3a071e12a622"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5df3e431080bf9fa4ff8a1f5ec2d2746"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d70/odpapi_8h.html#a5df3e431080bf9fa4ff8a1f5ec2d2746">ODPAPI_MOVESTATUS</a> { <br/>
&#160;&#160;<a class="el" href="../../d0/d70/odpapi_8h.html#a5df3e431080bf9fa4ff8a1f5ec2d2746ac30e90c854133626811c6f38b4914401">ODPAPI_MOVESTATUS_OK</a> = 0, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a5df3e431080bf9fa4ff8a1f5ec2d2746a1d3ef36eedfb015933f7cef7759c54e2">ODPAPI_MOVESTATUS_UNKNOWN</a> = 1, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a5df3e431080bf9fa4ff8a1f5ec2d2746a802f3cd4f136e7715624562ecfb9acd1">ODPAPI_MOVESTATUS_NOTINLIBRARY</a> = 2, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a5df3e431080bf9fa4ff8a1f5ec2d2746a84c64b2e7a83398287984fd9d1a2c118">ODPAPI_MOVESTATUS_DATAERROR</a> = 3, 
<br/>
&#160;&#160;<a class="el" href="../../d0/d70/odpapi_8h.html#a5df3e431080bf9fa4ff8a1f5ec2d2746aa46d21c34882f2efada88193493fa672">ODPAPI_MOVESTATUS_FAILED</a> = 4, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a5df3e431080bf9fa4ff8a1f5ec2d2746a1d31ad892f1af6a3697b4d140acaed56">ODPAPI_MOVESTATUS_MOVENOTREQUIRED</a> = 5, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a5df3e431080bf9fa4ff8a1f5ec2d2746a64ecdef7d3974a1cf7ed7ea3dadfff02">ODPAPI_MOVESTATUS_INVALIDVALUE</a> = 6
<br/>
 }</td></tr>
<tr class="separator:a5df3e431080bf9fa4ff8a1f5ec2d2746"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac158a19a0076dd0108f469e245af0dc2"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d70/odpapi_8h.html#ac158a19a0076dd0108f469e245af0dc2">ODPAPI_SCANSTATUS</a> { <br/>
&#160;&#160;<a class="el" href="../../d0/d70/odpapi_8h.html#ac158a19a0076dd0108f469e245af0dc2a016e7acfbd8af8d0f11c78defcbd5646">ODPAPI_SCANSTATUS_OK</a> = 0, 
<a class="el" href="../../d0/d70/odpapi_8h.html#ac158a19a0076dd0108f469e245af0dc2adcb803fd8c24c19d7fcfbf2aff82fa80">ODPAPI_SCANSTATUS_DATAERROR</a> = 1, 
<a class="el" href="../../d0/d70/odpapi_8h.html#ac158a19a0076dd0108f469e245af0dc2ada1a774e5d4c80e7dc6d89f01f867c52">ODPAPI_SCANSTATUS_UNKNOWN</a> = 2, 
<a class="el" href="../../d0/d70/odpapi_8h.html#ac158a19a0076dd0108f469e245af0dc2aec4aa9f83dd9ae333b3a1a3401251898">ODPAPI_SCANSTATUS_FAILED</a> = 3, 
<br/>
&#160;&#160;<a class="el" href="../../d0/d70/odpapi_8h.html#ac158a19a0076dd0108f469e245af0dc2acd5f0d5d680214bc9250b55a89cfe1a9">ODPAPI_SCANSTATUS_INVALIDVALUE</a> = 4
<br/>
 }</td></tr>
<tr class="separator:ac158a19a0076dd0108f469e245af0dc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ef5ef162d0b77c52b4f3c17d5b769b2"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d70/odpapi_8h.html#a0ef5ef162d0b77c52b4f3c17d5b769b2">ODPAPI_ADDSTATUS</a> { <br/>
&#160;&#160;<a class="el" href="../../d0/d70/odpapi_8h.html#a0ef5ef162d0b77c52b4f3c17d5b769b2aadaf8ea919d433590cbe0ec373f466ba">ODPAPI_ADDSTATUS_OK</a> = 0, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a0ef5ef162d0b77c52b4f3c17d5b769b2ab61a87a6f99ef0ca106046c9d6325d0b">ODPAPI_ADDSTATUS_DATAERROR</a> = 1, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a0ef5ef162d0b77c52b4f3c17d5b769b2a223a418b18c3db8424d6ac763a4fdf74">ODPAPI_ADDSTATUS_EXISTS</a> = 2, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a0ef5ef162d0b77c52b4f3c17d5b769b2a11e7a9e9c77b9fc4b6f9b61c00340ca9">ODPAPI_ADDSTATUS_EXISTSOTHERLIBRARY</a> = 3, 
<br/>
&#160;&#160;<a class="el" href="../../d0/d70/odpapi_8h.html#a0ef5ef162d0b77c52b4f3c17d5b769b2aeb984769145dfad537873410dc095966">ODPAPI_ADDSTATUS_FAILED</a> = 4, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a0ef5ef162d0b77c52b4f3c17d5b769b2a56320bbdc84134c2d31d970d45ab323f">ODPAPI_ADDSTATUS_INVALIDVALUE</a> = 5
<br/>
 }</td></tr>
<tr class="separator:a0ef5ef162d0b77c52b4f3c17d5b769b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1809172bdc7b081cca9533482c4ba688"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d70/odpapi_8h.html#a1809172bdc7b081cca9533482c4ba688">ODPAPI_SCANTYPE</a> { <a class="el" href="../../d0/d70/odpapi_8h.html#a1809172bdc7b081cca9533482c4ba688ad6f706fe69058dbdcfa7516f6c8bd1ee">ODPAPI_SCANTYPE_UNDEFINED</a> = 0, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a1809172bdc7b081cca9533482c4ba688a8e07d58bc8dc8c71a0f9b93d6a5d3bc2">ODPAPI_SCANTYPE_IN</a> = 1, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a1809172bdc7b081cca9533482c4ba688a5ab5419ede5f195ea735f84bb96bc571">ODPAPI_SCANTYPE_OUT</a> = 2, 
<a class="el" href="../../d0/d70/odpapi_8h.html#a1809172bdc7b081cca9533482c4ba688a4892ce5df7cd08f1879ee757b9ce5f92">ODPAPI_SCANTYPE_AUDIT</a> = 3
 }</td></tr>
<tr class="separator:a1809172bdc7b081cca9533482c4ba688"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8debbd76bf22a3ce3b7b2d865abed648"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d70/odpapi_8h.html#a8debbd76bf22a3ce3b7b2d865abed648">odpapi_format_common_result_text</a> (char *buffer, size_t length, enum <a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87">ODPAPI_COMMONERROR</a> error)</td></tr>
<tr class="memdesc:a8debbd76bf22a3ce3b7b2d865abed648"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a text representation for a given common error enumeration.  <a href="#a8debbd76bf22a3ce3b7b2d865abed648"></a><br/></td></tr>
<tr class="separator:a8debbd76bf22a3ce3b7b2d865abed648"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed8e60a1ba06717416d5141af6ad2bc5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d70/odpapi_8h.html#aed8e60a1ba06717416d5141af6ad2bc5">odpapi_response_prolog</a> (<a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *root, char *adaptername)</td></tr>
<tr class="memdesc:aed8e60a1ba06717416d5141af6ad2bc5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> control area with meta and response sections.  <a href="#aed8e60a1ba06717416d5141af6ad2bc5"></a><br/></td></tr>
<tr class="separator:aed8e60a1ba06717416d5141af6ad2bc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41d9d125419e40138d3573c62e9892a7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d70/odpapi_8h.html#a41d9d125419e40138d3573c62e9892a7">odpapi_response_epilog</a> (<a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *root, enum <a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87">ODPAPI_COMMONERROR</a> error, char *hint)</td></tr>
<tr class="memdesc:a41d9d125419e40138d3573c62e9892a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the response section with an integer and string representation of the ODPAPI function result.  <a href="#a41d9d125419e40138d3573c62e9892a7"></a><br/></td></tr>
<tr class="separator:a41d9d125419e40138d3573c62e9892a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfb18eac7f57290fe16965746202459e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d70/odpapi_8h.html#abfb18eac7f57290fe16965746202459e">odpapi_request_get_value</a> (<a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *json, char *key)</td></tr>
<tr class="memdesc:abfb18eac7f57290fe16965746202459e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Locates a <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> element for a given key.  <a href="#abfb18eac7f57290fe16965746202459e"></a><br/></td></tr>
<tr class="separator:abfb18eac7f57290fe16965746202459e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae7c9c555eb8f8005d5a4432c5066194"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d70/odpapi_8h.html#aae7c9c555eb8f8005d5a4432c5066194">odpapi_request_get_request</a> (<a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *root)</td></tr>
<tr class="memdesc:aae7c9c555eb8f8005d5a4432c5066194"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds the request section.  <a href="#aae7c9c555eb8f8005d5a4432c5066194"></a><br/></td></tr>
<tr class="separator:aae7c9c555eb8f8005d5a4432c5066194"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a403fda3fa007514b66a723a747a743d4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d70/odpapi_8h.html#a403fda3fa007514b66a723a747a743d4">odpapi_move_response_helper</a> (<a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *responsearray, enum <a class="el" href="../../d0/d70/odpapi_8h.html#a5df3e431080bf9fa4ff8a1f5ec2d2746">ODPAPI_MOVESTATUS</a> status, int sequence, char *id, char *type, char *movedate, char *hint)</td></tr>
<tr class="memdesc:a403fda3fa007514b66a723a747a743d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a Move Response Element.  <a href="#a403fda3fa007514b66a723a747a743d4"></a><br/></td></tr>
<tr class="separator:a403fda3fa007514b66a723a747a743d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00ee9474cd43f8889035a3d3289614ee"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d70/odpapi_8h.html#a00ee9474cd43f8889035a3d3289614ee">odpapi_inventory_response_helper</a> (<a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *responsearray, enum <a class="el" href="../../d0/d70/odpapi_8h.html#a0dba2207de5e8ecc9baa3a071e12a622">ODPAPI_INVENTORYSTATUS</a> status, int sequence, char *id, char *type, char *description, char *movedate, int encrypted, int scratch, int automatemovedate)</td></tr>
<tr class="memdesc:a00ee9474cd43f8889035a3d3289614ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an Inventory Response Element.  <a href="#a00ee9474cd43f8889035a3d3289614ee"></a><br/></td></tr>
<tr class="separator:a00ee9474cd43f8889035a3d3289614ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ceaab717a211f5c24ddc9f27ddc8987"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d70/odpapi_8h.html#a1ceaab717a211f5c24ddc9f27ddc8987">odpapi_scan_response_helper</a> (<a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *responsearray, enum <a class="el" href="../../d0/d70/odpapi_8h.html#ac158a19a0076dd0108f469e245af0dc2">ODPAPI_SCANSTATUS</a> status, int sequence, char *id, char *type, char *hint)</td></tr>
<tr class="memdesc:a1ceaab717a211f5c24ddc9f27ddc8987"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a Scan Response Element.  <a href="#a1ceaab717a211f5c24ddc9f27ddc8987"></a><br/></td></tr>
<tr class="separator:a1ceaab717a211f5c24ddc9f27ddc8987"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67aecd120044b4d19aaa28d4be821a01"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d70/odpapi_8h.html#a67aecd120044b4d19aaa28d4be821a01">odpapi_add_response_helper</a> (<a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *responsearray, enum <a class="el" href="../../d0/d70/odpapi_8h.html#a0ef5ef162d0b77c52b4f3c17d5b769b2">ODPAPI_ADDSTATUS</a> status, int sequence, char *id, char *hint)</td></tr>
<tr class="memdesc:a67aecd120044b4d19aaa28d4be821a01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an Add Response Element.  <a href="#a67aecd120044b4d19aaa28d4be821a01"></a><br/></td></tr>
<tr class="separator:a67aecd120044b4d19aaa28d4be821a01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affbcad7cbfaba6d69f9943af2ef06a0d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d70/odpapi_8h.html#affbcad7cbfaba6d69f9943af2ef06a0d">odpapi_list_response_helper</a> (<a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *responsearray, int sequence, char *description, char *guid, unsigned int capacity, unsigned int capacityused, unsigned int movingin, unsigned int movingout, int automatemovedate, char **targetguids)</td></tr>
<tr class="memdesc:affbcad7cbfaba6d69f9943af2ef06a0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a Library List Response Element.  <a href="#affbcad7cbfaba6d69f9943af2ef06a0d"></a><br/></td></tr>
<tr class="separator:affbcad7cbfaba6d69f9943af2ef06a0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Open Data Protection API Helper Header. </p>
<p>This file containers the prototypes and enumerations used by The Open Data Protection Helper functions.</p>
<dl class="section author"><dt>Author</dt><dd>Gerard J. Nicol (<a href="#" onclick="location.href='mai'+'lto:'+'ger'+'ar'+'d.n'+'ic'+'ol@'+'ga'+'zil'+'la'+'byt'+'e.'+'com'; return false;">gerar<span style="display: none;">.nosp@m.</span>d.ni<span style="display: none;">.nosp@m.</span>col@g<span style="display: none;">.nosp@m.</span>azil<span style="display: none;">.nosp@m.</span>labyt<span style="display: none;">.nosp@m.</span>e.co<span style="display: none;">.nosp@m.</span>m</a>) </dd></dl>
<dl class="bug"><dt><b><a class="el" href="../../de/da5/bug.html#_bug000001">Bug:</a></b></dt><dd>No known bugs. </dd></dl>

<p>Definition in file <a class="el" href="../../d0/d70/odpapi_8h_source.html">odpapi.h</a>.</p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a0ef5ef162d0b77c52b4f3c17d5b769b2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="../../d0/d70/odpapi_8h.html#a0ef5ef162d0b77c52b4f3c17d5b769b2">ODPAPI_ADDSTATUS</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a0ef5ef162d0b77c52b4f3c17d5b769b2aadaf8ea919d433590cbe0ec373f466ba"></a>ODPAPI_ADDSTATUS_OK</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0ef5ef162d0b77c52b4f3c17d5b769b2ab61a87a6f99ef0ca106046c9d6325d0b"></a>ODPAPI_ADDSTATUS_DATAERROR</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0ef5ef162d0b77c52b4f3c17d5b769b2a223a418b18c3db8424d6ac763a4fdf74"></a>ODPAPI_ADDSTATUS_EXISTS</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0ef5ef162d0b77c52b4f3c17d5b769b2a11e7a9e9c77b9fc4b6f9b61c00340ca9"></a>ODPAPI_ADDSTATUS_EXISTSOTHERLIBRARY</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0ef5ef162d0b77c52b4f3c17d5b769b2aeb984769145dfad537873410dc095966"></a>ODPAPI_ADDSTATUS_FAILED</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0ef5ef162d0b77c52b4f3c17d5b769b2a56320bbdc84134c2d31d970d45ab323f"></a>ODPAPI_ADDSTATUS_INVALIDVALUE</em>&nbsp;</td><td class="fielddoc">
</td></tr>
</table>

<p>Definition at line <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00062">62</a> of file <a class="el" href="../../d0/d70/odpapi_8h_source.html">odpapi.h</a>.</p>

</div>
</div>
<a class="anchor" id="a173a55e8071a19a0345ead2067182a87"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87">ODPAPI_COMMONERROR</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a173a55e8071a19a0345ead2067182a87a30abc33722887bbb08c59eb1ee160e4e"></a>ODPAPI_COMMONERROR_OK</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a173a55e8071a19a0345ead2067182a87ac2f45ac381df116b97f544962cbfac54"></a>ODPAPI_COMMONERROR_PARSEFAILED</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a173a55e8071a19a0345ead2067182a87a951196c13fb81f4d08d9b6a78dcb1f3e"></a>ODPAPI_COMMONERROR_NOTOFFERED</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a173a55e8071a19a0345ead2067182a87af5150692024af47879b46297e2fc1214"></a>ODPAPI_COMMONERROR_NOTPERMITTED</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a173a55e8071a19a0345ead2067182a87a71158f3119c02bdb87d81aa182ebcdb9"></a>ODPAPI_COMMONERROR_FAILEDAUTH</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a173a55e8071a19a0345ead2067182a87a71da0fd6e79b4974e2982ee584130b85"></a>ODPAPI_COMMONERROR_ERRORCOMEBACK</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a173a55e8071a19a0345ead2067182a87a130853a151379bc3aae710760699e216"></a>ODPAPI_COMMONERROR_EXCEEDEDALLOWANCE</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a173a55e8071a19a0345ead2067182a87aff3d720e4702d648f3b89c2b4a947d8d"></a>ODPAPI_COMMONERROR_INVALIDUUID</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a173a55e8071a19a0345ead2067182a87aca609ac007f0dd1b1c03da8dca227a79"></a>ODPAPI_COMMONERROR_MISSINGARGUMENT</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a173a55e8071a19a0345ead2067182a87a6d7f4258803c0e6f9ffef1861b4f1d5e"></a>ODPAPI_COMMONERROR_MISSINGDATA</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a173a55e8071a19a0345ead2067182a87a0efa20b1ce95a23a78bf5589c57e55d8"></a>ODPAPI_COMMONERROR_SOURCELIBRARYNOTKNOWN</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a173a55e8071a19a0345ead2067182a87ab492457a23bada291884a0d24988eaeb"></a>ODPAPI_COMMONERROR_TARGETLIBRARYNOTKNOWN</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a173a55e8071a19a0345ead2067182a87af756e12cea8f4d9297c04cba5e16be71"></a>ODPAPI_COMMONERROR_TARGETLIBRARYSAME</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a173a55e8071a19a0345ead2067182a87a11faffa78ea05084745b2b0225da7f27"></a>ODPAPI_COMMONERROR_LIBRARYCOMPATPROBLEM</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a173a55e8071a19a0345ead2067182a87a55afde4b2afe4f4c28432fc63f9e28aa"></a>ODPAPI_COMMONERROR_UNKNOWN</em>&nbsp;</td><td class="fielddoc">
</td></tr>
</table>

<p>Definition at line <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00015">15</a> of file <a class="el" href="../../d0/d70/odpapi_8h_source.html">odpapi.h</a>.</p>

</div>
</div>
<a class="anchor" id="a0dba2207de5e8ecc9baa3a071e12a622"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="../../d0/d70/odpapi_8h.html#a0dba2207de5e8ecc9baa3a071e12a622">ODPAPI_INVENTORYSTATUS</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a0dba2207de5e8ecc9baa3a071e12a622a9a072be090d2f9f5083399db90b5c79b"></a>ODPAPI_INVENTORYSTATUS_OK</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0dba2207de5e8ecc9baa3a071e12a622ad0600615bafe4dbf15f12b2573631c1b"></a>ODPAPI_INVENTORYSTATUS_MOVINGIN</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0dba2207de5e8ecc9baa3a071e12a622adc37834085db8595cfb5544870185143"></a>ODPAPI_INVENTORYSTATUS_MOVINGOUT</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0dba2207de5e8ecc9baa3a071e12a622a62b49934707eab32ec1b9193e443b190"></a>ODPAPI_INVENTORYSTATUS_NOTPRESENT</em>&nbsp;</td><td class="fielddoc">
</td></tr>
</table>

<p>Definition at line <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00037">37</a> of file <a class="el" href="../../d0/d70/odpapi_8h_source.html">odpapi.h</a>.</p>

</div>
</div>
<a class="anchor" id="a5df3e431080bf9fa4ff8a1f5ec2d2746"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="../../d0/d70/odpapi_8h.html#a5df3e431080bf9fa4ff8a1f5ec2d2746">ODPAPI_MOVESTATUS</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a5df3e431080bf9fa4ff8a1f5ec2d2746ac30e90c854133626811c6f38b4914401"></a>ODPAPI_MOVESTATUS_OK</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a5df3e431080bf9fa4ff8a1f5ec2d2746a1d3ef36eedfb015933f7cef7759c54e2"></a>ODPAPI_MOVESTATUS_UNKNOWN</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a5df3e431080bf9fa4ff8a1f5ec2d2746a802f3cd4f136e7715624562ecfb9acd1"></a>ODPAPI_MOVESTATUS_NOTINLIBRARY</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a5df3e431080bf9fa4ff8a1f5ec2d2746a84c64b2e7a83398287984fd9d1a2c118"></a>ODPAPI_MOVESTATUS_DATAERROR</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a5df3e431080bf9fa4ff8a1f5ec2d2746aa46d21c34882f2efada88193493fa672"></a>ODPAPI_MOVESTATUS_FAILED</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a5df3e431080bf9fa4ff8a1f5ec2d2746a1d31ad892f1af6a3697b4d140acaed56"></a>ODPAPI_MOVESTATUS_MOVENOTREQUIRED</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a5df3e431080bf9fa4ff8a1f5ec2d2746a64ecdef7d3974a1cf7ed7ea3dadfff02"></a>ODPAPI_MOVESTATUS_INVALIDVALUE</em>&nbsp;</td><td class="fielddoc">
</td></tr>
</table>

<p>Definition at line <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00044">44</a> of file <a class="el" href="../../d0/d70/odpapi_8h_source.html">odpapi.h</a>.</p>

</div>
</div>
<a class="anchor" id="ac158a19a0076dd0108f469e245af0dc2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="../../d0/d70/odpapi_8h.html#ac158a19a0076dd0108f469e245af0dc2">ODPAPI_SCANSTATUS</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ac158a19a0076dd0108f469e245af0dc2a016e7acfbd8af8d0f11c78defcbd5646"></a>ODPAPI_SCANSTATUS_OK</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ac158a19a0076dd0108f469e245af0dc2adcb803fd8c24c19d7fcfbf2aff82fa80"></a>ODPAPI_SCANSTATUS_DATAERROR</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ac158a19a0076dd0108f469e245af0dc2ada1a774e5d4c80e7dc6d89f01f867c52"></a>ODPAPI_SCANSTATUS_UNKNOWN</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ac158a19a0076dd0108f469e245af0dc2aec4aa9f83dd9ae333b3a1a3401251898"></a>ODPAPI_SCANSTATUS_FAILED</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ac158a19a0076dd0108f469e245af0dc2acd5f0d5d680214bc9250b55a89cfe1a9"></a>ODPAPI_SCANSTATUS_INVALIDVALUE</em>&nbsp;</td><td class="fielddoc">
</td></tr>
</table>

<p>Definition at line <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00054">54</a> of file <a class="el" href="../../d0/d70/odpapi_8h_source.html">odpapi.h</a>.</p>

</div>
</div>
<a class="anchor" id="a1809172bdc7b081cca9533482c4ba688"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="../../d0/d70/odpapi_8h.html#a1809172bdc7b081cca9533482c4ba688">ODPAPI_SCANTYPE</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a1809172bdc7b081cca9533482c4ba688ad6f706fe69058dbdcfa7516f6c8bd1ee"></a>ODPAPI_SCANTYPE_UNDEFINED</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a1809172bdc7b081cca9533482c4ba688a8e07d58bc8dc8c71a0f9b93d6a5d3bc2"></a>ODPAPI_SCANTYPE_IN</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a1809172bdc7b081cca9533482c4ba688a5ab5419ede5f195ea735f84bb96bc571"></a>ODPAPI_SCANTYPE_OUT</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a1809172bdc7b081cca9533482c4ba688a4892ce5df7cd08f1879ee757b9ce5f92"></a>ODPAPI_SCANTYPE_AUDIT</em>&nbsp;</td><td class="fielddoc">
</td></tr>
</table>

<p>Definition at line <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00071">71</a> of file <a class="el" href="../../d0/d70/odpapi_8h_source.html">odpapi.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a67aecd120044b4d19aaa28d4be821a01"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void odpapi_add_response_helper </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td>
          <td class="paramname"><em>responsearray</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="../../d0/d70/odpapi_8h.html#a0ef5ef162d0b77c52b4f3c17d5b769b2">ODPAPI_ADDSTATUS</a>&#160;</td>
          <td class="paramname"><em>status</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>sequence</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>hint</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates an Add Response Element. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">responsearray</td><td>Pointer to the <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> response array node </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00382">382</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>References <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00520">cJSON_AddItemToArray()</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00133">cJSON_AddNumberToObject</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00134">cJSON_AddStringToObject</a>, and <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00545">cJSON_CreateObject()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d0/d70/odpapi_8h_a67aecd120044b4d19aaa28d4be821a01_cgraph.png" border="0" usemap="#d0/d70/odpapi_8h_a67aecd120044b4d19aaa28d4be821a01_cgraph" alt=""/></div>
<map name="d0/d70/odpapi_8h_a67aecd120044b4d19aaa28d4be821a01_cgraph" id="d0/d70/odpapi_8h_a67aecd120044b4d19aaa28d4be821a01_cgraph">
<area shape="rect" id="node2" href="../../dd/d21/cJSON_8c.html#a164dcefd36af8654942116c444bd0b6a" title="cJSON_AddItemToArray" alt="" coords="203,5,365,32"/><area shape="rect" id="node4" href="../../dd/d21/cJSON_8c.html#a9c5f44afdd781b16dead90042fe74085" title="cJSON_CreateObject" alt="" coords="211,56,357,83"/><area shape="rect" id="node3" href="../../dd/d21/cJSON_8c.html#a5d61bcc0045ace88c2ae04f0928eeace" title="suffix_object" alt="" coords="430,5,525,32"/><area shape="rect" id="node5" href="../../dd/d21/cJSON_8c.html#a39a97485cfb9d19bad65a0522faea19f" title="cJSON_New_Item" alt="" coords="414,56,541,83"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a8debbd76bf22a3ce3b7b2d865abed648"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* odpapi_format_common_result_text </td>
          <td>(</td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87">ODPAPI_COMMONERROR</a>&#160;</td>
          <td class="paramname"><em>error</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a text representation for a given common error enumeration. </p>
<p>It is recommended that you provide at least 256 bytes of storage for the result area. This function will also return the address of the storage area as a result so that it can be used inline in other fucntions, such as fprintf.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">buffer</td><td>The address of the storage buffer to receive the result </td></tr>
    <tr><td class="paramname">length</td><td>The length of the storage buffer to receive the result </td></tr>
    <tr><td class="paramname">error</td><td>The Open Data Protection API common error code value </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The address of the storage areacommon error value </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">buffer</td><td>pointer to storage for result </td></tr>
    <tr><td class="paramname">length</td><td>size of storage for result </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00014">14</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>References <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00021">ODPAPI_COMMONERROR_ERRORCOMEBACK</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00022">ODPAPI_COMMONERROR_EXCEEDEDALLOWANCE</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00020">ODPAPI_COMMONERROR_FAILEDAUTH</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00023">ODPAPI_COMMONERROR_INVALIDUUID</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00024">ODPAPI_COMMONERROR_MISSINGARGUMENT</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00018">ODPAPI_COMMONERROR_NOTOFFERED</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00019">ODPAPI_COMMONERROR_NOTPERMITTED</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00016">ODPAPI_COMMONERROR_OK</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00017">ODPAPI_COMMONERROR_PARSEFAILED</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00028">ODPAPI_COMMONERROR_SOURCELIBRARYNOTKNOWN</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00029">ODPAPI_COMMONERROR_TARGETLIBRARYNOTKNOWN</a>, and <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00030">ODPAPI_COMMONERROR_TARGETLIBRARYSAME</a>.</p>

<p>Referenced by <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00066">odpapi_response_epilog()</a>.</p>

</div>
</div>
<a class="anchor" id="a00ee9474cd43f8889035a3d3289614ee"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void odpapi_inventory_response_helper </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td>
          <td class="paramname"><em>responsearray</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="../../d0/d70/odpapi_8h.html#a0dba2207de5e8ecc9baa3a071e12a622">ODPAPI_INVENTORYSTATUS</a>&#160;</td>
          <td class="paramname"><em>status</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>sequence</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>description</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>movedate</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>encrypted</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>scratch</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>automatemovedate</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates an Inventory Response Element. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">responsearray</td><td>Pointer to the <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> response array node </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00252">252</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>References <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00132">cJSON_AddBoolToObject</a>, <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00520">cJSON_AddItemToArray()</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00133">cJSON_AddNumberToObject</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00134">cJSON_AddStringToObject</a>, and <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00545">cJSON_CreateObject()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d0/d70/odpapi_8h_a00ee9474cd43f8889035a3d3289614ee_cgraph.png" border="0" usemap="#d0/d70/odpapi_8h_a00ee9474cd43f8889035a3d3289614ee_cgraph" alt=""/></div>
<map name="d0/d70/odpapi_8h_a00ee9474cd43f8889035a3d3289614ee_cgraph" id="d0/d70/odpapi_8h_a00ee9474cd43f8889035a3d3289614ee_cgraph">
<area shape="rect" id="node2" href="../../dd/d21/cJSON_8c.html#a164dcefd36af8654942116c444bd0b6a" title="cJSON_AddItemToArray" alt="" coords="232,5,395,32"/><area shape="rect" id="node4" href="../../dd/d21/cJSON_8c.html#a9c5f44afdd781b16dead90042fe74085" title="cJSON_CreateObject" alt="" coords="240,56,387,83"/><area shape="rect" id="node3" href="../../dd/d21/cJSON_8c.html#a5d61bcc0045ace88c2ae04f0928eeace" title="suffix_object" alt="" coords="459,5,554,32"/><area shape="rect" id="node5" href="../../dd/d21/cJSON_8c.html#a39a97485cfb9d19bad65a0522faea19f" title="cJSON_New_Item" alt="" coords="443,56,570,83"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="affbcad7cbfaba6d69f9943af2ef06a0d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a>* odpapi_list_response_helper </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td>
          <td class="paramname"><em>responsearray</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>sequence</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>description</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>guid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>capacity</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>capacityused</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>movingin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>movingout</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>automatemovedate</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char **&#160;</td>
          <td class="paramname"><em>targetguids</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates a Library List Response Element. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">responsearray</td><td>Pointer to the <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> response array node </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00299">299</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>References <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00132">cJSON_AddBoolToObject</a>, <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00520">cJSON_AddItemToArray()</a>, <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00521">cJSON_AddItemToObject()</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00133">cJSON_AddNumberToObject</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00134">cJSON_AddStringToObject</a>, <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00544">cJSON_CreateArray()</a>, <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00545">cJSON_CreateObject()</a>, and <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00543">cJSON_CreateString()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d0/d70/odpapi_8h_affbcad7cbfaba6d69f9943af2ef06a0d_cgraph.png" border="0" usemap="#d0/d70/odpapi_8h_affbcad7cbfaba6d69f9943af2ef06a0d_cgraph" alt=""/></div>
<map name="d0/d70/odpapi_8h_affbcad7cbfaba6d69f9943af2ef06a0d_cgraph" id="d0/d70/odpapi_8h_affbcad7cbfaba6d69f9943af2ef06a0d_cgraph">
<area shape="rect" id="node2" href="../../dd/d21/cJSON_8c.html#a164dcefd36af8654942116c444bd0b6a" title="cJSON_AddItemToArray" alt="" coords="416,5,579,32"/><area shape="rect" id="node4" href="../../dd/d21/cJSON_8c.html#a096004811663311569e95aa77518959c" title="cJSON_AddItemToObject" alt="" coords="197,43,368,69"/><area shape="rect" id="node6" href="../../dd/d21/cJSON_8c.html#a29e5808c66c1cf1f3edbf117babe07b3" title="cJSON_CreateArray" alt="" coords="213,144,352,171"/><area shape="rect" id="node8" href="../../dd/d21/cJSON_8c.html#a9c5f44afdd781b16dead90042fe74085" title="cJSON_CreateObject" alt="" coords="209,195,356,221"/><area shape="rect" id="node9" href="../../dd/d21/cJSON_8c.html#a5987bbc1c94d9f602d719a4015ff0e6c" title="cJSON_CreateString" alt="" coords="211,93,354,120"/><area shape="rect" id="node3" href="../../dd/d21/cJSON_8c.html#a5d61bcc0045ace88c2ae04f0928eeace" title="suffix_object" alt="" coords="627,5,722,32"/><area shape="rect" id="node5" href="../../dd/d21/cJSON_8c.html#a52edadd0bf81e05a1fb04200388475f9" title="cJSON_strdup" alt="" coords="444,81,551,108"/><area shape="rect" id="node7" href="../../dd/d21/cJSON_8c.html#a39a97485cfb9d19bad65a0522faea19f" title="cJSON_New_Item" alt="" coords="434,144,561,171"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a403fda3fa007514b66a723a747a743d4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void odpapi_move_response_helper </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td>
          <td class="paramname"><em>responsearray</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="../../d0/d70/odpapi_8h.html#a5df3e431080bf9fa4ff8a1f5ec2d2746">ODPAPI_MOVESTATUS</a>&#160;</td>
          <td class="paramname"><em>status</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>sequence</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>movedate</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>hint</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates a Move Response Element. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">responsearray</td><td>Pointer to the <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> response array node </td></tr>
    <tr><td class="paramname">status</td><td>enumeration representing the status of this element </td></tr>
    <tr><td class="paramname">sequence</td><td>index of element (starting at zero) </td></tr>
    <tr><td class="paramname">id</td><td>object id string </td></tr>
    <tr><td class="paramname">movedate</td><td>move_date value in ISO date format </td></tr>
    <tr><td class="paramname">hint</td><td>of any error </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00217">217</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>References <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00520">cJSON_AddItemToArray()</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00133">cJSON_AddNumberToObject</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00134">cJSON_AddStringToObject</a>, and <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00545">cJSON_CreateObject()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d0/d70/odpapi_8h_a403fda3fa007514b66a723a747a743d4_cgraph.png" border="0" usemap="#d0/d70/odpapi_8h_a403fda3fa007514b66a723a747a743d4_cgraph" alt=""/></div>
<map name="d0/d70/odpapi_8h_a403fda3fa007514b66a723a747a743d4_cgraph" id="d0/d70/odpapi_8h_a403fda3fa007514b66a723a747a743d4_cgraph">
<area shape="rect" id="node2" href="../../dd/d21/cJSON_8c.html#a164dcefd36af8654942116c444bd0b6a" title="cJSON_AddItemToArray" alt="" coords="211,5,373,32"/><area shape="rect" id="node4" href="../../dd/d21/cJSON_8c.html#a9c5f44afdd781b16dead90042fe74085" title="cJSON_CreateObject" alt="" coords="219,56,365,83"/><area shape="rect" id="node3" href="../../dd/d21/cJSON_8c.html#a5d61bcc0045ace88c2ae04f0928eeace" title="suffix_object" alt="" coords="438,5,533,32"/><area shape="rect" id="node5" href="../../dd/d21/cJSON_8c.html#a39a97485cfb9d19bad65a0522faea19f" title="cJSON_New_Item" alt="" coords="422,56,549,83"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="aae7c9c555eb8f8005d5a4432c5066194"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a>* odpapi_request_get_request </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td>
          <td class="paramname"><em>root</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Finds the request section. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">root</td><td>The <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> rootpointer to the <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> request root </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00172">172</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>References <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00045">cJSON::child</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00044">cJSON::next</a>, and <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00053">cJSON::string</a>.</p>

</div>
</div>
<a class="anchor" id="abfb18eac7f57290fe16965746202459e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a>* odpapi_request_get_value </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td>
          <td class="paramname"><em>json</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>key</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Locates a <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> element for a given key. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">json</td><td>The <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> branch for search </td></tr>
    <tr><td class="paramname">key</td><td>The key being searched forstring to search for </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">json</td><td>pointer to <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> node </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00194">194</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>References <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00045">cJSON::child</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00044">cJSON::next</a>, and <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00053">cJSON::string</a>.</p>

<p>Referenced by <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00066">odpapi_response_epilog()</a>.</p>

</div>
</div>
<a class="anchor" id="a41d9d125419e40138d3573c62e9892a7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void odpapi_response_epilog </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td>
          <td class="paramname"><em>root</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87">ODPAPI_COMMONERROR</a>&#160;</td>
          <td class="paramname"><em>error</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>hint</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the response section with an integer and string representation of the ODPAPI function result. </p>
<p>This function will look for an existing response section (created by odpapi_response_prolog) and set the result and result_text field to the value passed as the error argument. If a response section can not be found, one will be created.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">root</td><td>The <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> root </td></tr>
    <tr><td class="paramname">error</td><td>The error returned by the ODPAPI function </td></tr>
    <tr><td class="paramname">hint</td><td>A string value giving further information on the error (or NULL)error hint text (or NULL) </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">root</td><td>pointer to <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> root </td></tr>
    <tr><td class="paramname">error</td><td>common error value </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00066">66</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>References <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00045">cJSON::child</a>, <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00521">cJSON_AddItemToObject()</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00133">cJSON_AddNumberToObject</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00134">cJSON_AddStringToObject</a>, <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00545">cJSON_CreateObject()</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00044">cJSON::next</a>, <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00014">odpapi_format_common_result_text()</a>, <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00194">odpapi_request_get_value()</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00053">cJSON::string</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00051">cJSON::valuedouble</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00050">cJSON::valueint</a>, and <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00049">cJSON::valuestring</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d0/d70/odpapi_8h_a41d9d125419e40138d3573c62e9892a7_cgraph.png" border="0" usemap="#d0/d70/odpapi_8h_a41d9d125419e40138d3573c62e9892a7_cgraph" alt=""/></div>
<map name="d0/d70/odpapi_8h_a41d9d125419e40138d3573c62e9892a7_cgraph" id="d0/d70/odpapi_8h_a41d9d125419e40138d3573c62e9892a7_cgraph">
<area shape="rect" id="node2" href="../../dd/d21/cJSON_8c.html#a096004811663311569e95aa77518959c" title="cJSON_AddItemToObject" alt="" coords="216,56,387,83"/><area shape="rect" id="node6" href="../../dd/d21/cJSON_8c.html#a9c5f44afdd781b16dead90042fe74085" title="cJSON_CreateObject" alt="" coords="228,107,375,133"/><area shape="rect" id="node8" href="../../d8/d4f/odpapi_8c.html#a8debbd76bf22a3ce3b7b2d865abed648" title="Returns a text representation for a given common error enumeration." alt="" coords="221,158,381,199"/><area shape="rect" id="node9" href="../../d8/d4f/odpapi_8c.html#abfb18eac7f57290fe16965746202459e" title="Locates a cJSON element for a given key." alt="" coords="234,223,369,265"/><area shape="rect" id="node3" href="../../dd/d21/cJSON_8c.html#a52edadd0bf81e05a1fb04200388475f9" title="cJSON_strdup" alt="" coords="463,5,569,32"/><area shape="rect" id="node4" href="../../dd/d21/cJSON_8c.html#a164dcefd36af8654942116c444bd0b6a" title="cJSON_AddItemToArray" alt="" coords="435,56,597,83"/><area shape="rect" id="node5" href="../../dd/d21/cJSON_8c.html#a5d61bcc0045ace88c2ae04f0928eeace" title="suffix_object" alt="" coords="646,56,741,83"/><area shape="rect" id="node7" href="../../dd/d21/cJSON_8c.html#a39a97485cfb9d19bad65a0522faea19f" title="cJSON_New_Item" alt="" coords="453,107,579,133"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="aed8e60a1ba06717416d5141af6ad2bc5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a>* odpapi_response_prolog </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td>
          <td class="paramname"><em>root</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>adaptername</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initializes <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> control area with meta and response sections. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">root</td><td>The <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> root pre-initialized with <a class="el" href="../../dd/d21/cJSON_8c.html#a9c5f44afdd781b16dead90042fe74085">cJSON_CreateObject()</a> </td></tr>
    <tr><td class="paramname">adaptername</td><td>A string representing the name of this ODPAPI adapter adapter name </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">root</td><td>pointer to <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> root </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00130">130</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>References <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00521">cJSON_AddItemToObject()</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00133">cJSON_AddNumberToObject</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00134">cJSON_AddStringToObject</a>, <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00545">cJSON_CreateObject()</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00034">ODPAPI_COMMONERROR_UNKNOWN</a>, and <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00007">ODPAPI_VERSION</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d0/d70/odpapi_8h_aed8e60a1ba06717416d5141af6ad2bc5_cgraph.png" border="0" usemap="#d0/d70/odpapi_8h_aed8e60a1ba06717416d5141af6ad2bc5_cgraph" alt=""/></div>
<map name="d0/d70/odpapi_8h_aed8e60a1ba06717416d5141af6ad2bc5_cgraph" id="d0/d70/odpapi_8h_aed8e60a1ba06717416d5141af6ad2bc5_cgraph">
<area shape="rect" id="node2" href="../../dd/d21/cJSON_8c.html#a096004811663311569e95aa77518959c" title="cJSON_AddItemToObject" alt="" coords="216,56,387,83"/><area shape="rect" id="node6" href="../../dd/d21/cJSON_8c.html#a9c5f44afdd781b16dead90042fe74085" title="cJSON_CreateObject" alt="" coords="228,107,375,133"/><area shape="rect" id="node3" href="../../dd/d21/cJSON_8c.html#a52edadd0bf81e05a1fb04200388475f9" title="cJSON_strdup" alt="" coords="463,5,569,32"/><area shape="rect" id="node4" href="../../dd/d21/cJSON_8c.html#a164dcefd36af8654942116c444bd0b6a" title="cJSON_AddItemToArray" alt="" coords="435,56,597,83"/><area shape="rect" id="node5" href="../../dd/d21/cJSON_8c.html#a5d61bcc0045ace88c2ae04f0928eeace" title="suffix_object" alt="" coords="646,56,741,83"/><area shape="rect" id="node7" href="../../dd/d21/cJSON_8c.html#a39a97485cfb9d19bad65a0522faea19f" title="cJSON_New_Item" alt="" coords="453,107,579,133"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a1ceaab717a211f5c24ddc9f27ddc8987"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void odpapi_scan_response_helper </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td>
          <td class="paramname"><em>responsearray</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="../../d0/d70/odpapi_8h.html#ac158a19a0076dd0108f469e245af0dc2">ODPAPI_SCANSTATUS</a>&#160;</td>
          <td class="paramname"><em>status</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>sequence</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>hint</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates a Scan Response Element. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">responsearray</td><td>Pointer to the <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> response array node </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00353">353</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>References <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00520">cJSON_AddItemToArray()</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00133">cJSON_AddNumberToObject</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00134">cJSON_AddStringToObject</a>, and <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00545">cJSON_CreateObject()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d0/d70/odpapi_8h_a1ceaab717a211f5c24ddc9f27ddc8987_cgraph.png" border="0" usemap="#d0/d70/odpapi_8h_a1ceaab717a211f5c24ddc9f27ddc8987_cgraph" alt=""/></div>
<map name="d0/d70/odpapi_8h_a1ceaab717a211f5c24ddc9f27ddc8987_cgraph" id="d0/d70/odpapi_8h_a1ceaab717a211f5c24ddc9f27ddc8987_cgraph">
<area shape="rect" id="node2" href="../../dd/d21/cJSON_8c.html#a164dcefd36af8654942116c444bd0b6a" title="cJSON_AddItemToArray" alt="" coords="208,5,371,32"/><area shape="rect" id="node4" href="../../dd/d21/cJSON_8c.html#a9c5f44afdd781b16dead90042fe74085" title="cJSON_CreateObject" alt="" coords="216,56,363,83"/><area shape="rect" id="node3" href="../../dd/d21/cJSON_8c.html#a5d61bcc0045ace88c2ae04f0928eeace" title="suffix_object" alt="" coords="435,5,530,32"/><area shape="rect" id="node5" href="../../dd/d21/cJSON_8c.html#a39a97485cfb9d19bad65a0522faea19f" title="cJSON_New_Item" alt="" coords="419,56,546,83"/></map>
</div>
</p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Feb 21 2014 17:13:55 for Open Data Protection C API by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>
